tools/utils/src/modules/array-[number-boolean].js

  1. /**
  2. * @module @svizzle/utils/array-[number-boolean]
  3. */
  5. import * as _ from 'lamb';
  7. /**
  8.  * Return a function expecting a number and returning true if the number is within the provided range.
  9.  * Note that the range is inclusive.
  10.  *
  11.  * @function
  12.  * @arg {array} range - Array of two numbers
  13.  * @return {function} predicate - Number -> Boolean
  14.  *
  15.  * @example
  16. > isWithinRange = makeIsWithinRange([0, 5])
  17. > isWithinRange(2)
  18. true
  19. > isWithinRange(5)
  20. true
  21. > isWithinRange(8)
  22. false
  23.  *
  24.  * @since 0.1.0
  25.  */
  26. export const makeIsWithinRange = range => _.allOf([
  27. 	_.isGTE(range[0]),
  28. 	_.isLTE(range[1])
  29. ]);